home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / prgtools / gnustuff / tos / othergnu / indent~1.zoo / indent.inf < prev    next >
Encoding:
GNU Info File  |  1992-08-06  |  38.1 KB  |  1,146 lines
  1. This is Info file indent.info, produced by Makeinfo-1.47 from the input
  2. file ./indent.texinfo.
  3.  
  4.    Copyright (C) 1989, 1992 Free Software Foundation, Inc.
  5.  
  6.    This is Edition 0.02, 5 May 1992, of `The `indent' Manual', for
  7. Indent Version 1.3
  8.  
  9.    Permission is granted to make and distribute verbatim copies of this
  10. manual provided the copyright notice and this permission notice are
  11. preserved on all copies.
  12.  
  14. File: indent.info,  Node: Top,  Next: Indent Program,  Prev: (dir),  Up: (dir)
  15.  
  16. `indent':  Indent and Format C Program Source
  17. *********************************************
  18.  
  19.    The `indent' program changes the appearance of a C program by
  20. inserting or deleting whitespace.
  21.  
  22.    This is Edition 0.02, May 1992, of `The `indent' Manual', for Indent
  23. Version 1.3
  24.  
  25. * Menu:
  26.  
  27. * Indent Program::              The `indent' Program
  28. * Option Summary::              Option Summary
  29. * Index::                       Index
  30.  
  32. File: indent.info,  Node: Indent Program,  Next: Option Summary,  Prev: Top,  Up: Top
  33.  
  34. The `indent' Program
  35. ********************
  36.  
  37.    The `indent' program can be used to make code easier to read.  It
  38. can also convert from one style of writing C to another.
  39.  
  40.    `indent' understands a substantial amount about the syntax of C, but
  41. it also attempts to cope with incomplete and misformed syntax.
  42.  
  43.    In version 1.2 and more recent versions, the GNU style of indenting
  44. is the default.
  45.  
  46. * Menu:
  47.  
  48. * Invoking indent::             Invoking `indent'
  49. * Backup files::                Backup Files
  50. * Common styles::               Common styles
  51. * Blank lines::                 Blank lines
  52. * Comments::                    Comments
  53. * Statements::                  Statements
  54. * Declarations::                Declarations
  55. * Indentation::                 Indentation
  56. * Miscellaneous options::       Miscellaneous options
  57. * Copyright::                   Copyright
  58.  
  60. File: indent.info,  Node: Invoking indent,  Next: Backup files,  Up: Indent Program
  61.  
  62. Invoking `indent'
  63. =================
  64.  
  65.    As of version 1.3, the format of the `indent' command is:
  66.  
  67.      indent [OPTIONS] [INPUT-FILES]
  68.      
  69.      indent [OPTIONS] [SINGLE-INPUT-FILE] [-o OUTPUT-FILE]
  70.  
  71.    This format is different from earlier versions and other versions of
  72. `indent'.
  73.  
  74.    In the first form, one or more input files are specified.  `indent'
  75. makes a backup copy of each file, and the original file is replaced with
  76. its indented version.  *Note Backup files::, for an explanation of how
  77. backups are made.
  78.  
  79.    In the second form, only one input file is specified.  In this case,
  80. or when the standard input is used, you may specify an output file after
  81. the `-o' option.
  82.  
  83.    To cause `indent' to write to standard output, use the `-st' option.
  84.  This is only allowed when there is only one input file, or when the
  85. standard input is used.
  86.  
  87.    If no input files are named, the standard input is read for input.
  88. Also, if a filename named `-' is specified, then the standard input is
  89. read.
  90.  
  91.    As an example, each of the following commands will input the program
  92. `slithy_toves.c' and write its indented text to `slithy_toves.out':
  93.  
  94.      indent slithy_toves.c -o slithy_toves.out
  95.      
  96.      indent -st slithy_toves.c > slithy_toves.out
  97.      
  98.      cat slithy_toves.c | indent -o slithy_toves.out
  99.  
  100.    Most other options to `indent' control how programs are formatted.
  101. As of version 1.2, `indent' also recognizes a long name for each option
  102. name.  Long options are prefixed by either `--' or `+'.(1) In most of
  103. this document, the traditional, short names are used for the sake of
  104. brevity. *Note Option Summary::, for a list of options, including both
  105. long and short names.
  106.  
  107.    Here is another example:
  108.  
  109.      indent -br test/metabolism.c -l85
  110.  
  111.    This will indent the program `test/metabolism.c' using the `-br' and
  112. `-l85' options, write the output back to `test/metabolism.c', and write
  113. the original contents of `test/metabolism.c' to a backup file in the
  114. directory `test'.
  115.  
  116.    Equivalent invocations using long option names for this example would
  117. be:
  118.  
  119.      indent --braces-on-if-line --line-length185 test/metabolism.c
  120.      
  121.      indent +braces-on-if-line +line-length185 test/metabolism.c
  122.  
  123.    If you find that you often use `indent' with the same options, you
  124. may put those options into a file called `.indent.pro'. `indent' will
  125. first look for `.indent.pro' in the current directory and use that if
  126. found.  Otherwise, `indent' will search your home directory for
  127. `.indent.pro' and use that file if it is found.  This behaviour is
  128. different from that of other versions of `indent', which load both
  129. files if they both exist.
  130.  
  131.    Command line switches are handled *after* processing `.indent.pro'. 
  132. Options specified later override arguments specified earlier, with one
  133. exception: Explicitly specified options always override background
  134. options (*note Common styles::.).  You can prevent `indent' from
  135. reading an `.indent.pro' file by specifying the `-npro' option.
  136.  
  137.    ---------- Footnotes ----------
  138.  
  139.    (1)   `+' is being superseded by `--' to maintain consistency with
  140. the POSIX standard.
  141.  
  143. File: indent.info,  Node: Backup files,  Next: Common styles,  Prev: Invoking indent,  Up: Indent Program
  144.  
  145. Backup Files
  146. ============
  147.  
  148.    As of version 1.3, GNU `indent' makes GNU--style backup files, the
  149. same way GNU Emacs does.  This means that either "simple" or "numbered"
  150. backup filenames may be made.
  151.  
  152.    Simple backup file names are generated by appending a suffix to the
  153. original file name.  The default for the this suffix is the
  154. one-character string `~' (tilde).  Thus, the backup file for `python.c'
  155. would be `python.c~'.
  156.  
  157.    Instead of the default, you may specify any string as a suffix by
  158. setting the environment variable `SIMPLE_BACKUP_SUFFIX' to your
  159. preferred suffix.
  160.  
  161.    Numbered backup versions of a file `momewraths' look like
  162. `momewraths.c.~23~', where 23 is the version of this particular backup.
  163.  When making a numbered backup of the file `src/momewrath.c', the
  164. backup file will be named `src/momewrath.c.~V~', where V is one greater
  165. than the highest version currently existing in the directory `src'.
  166.  
  167.    The type of backup file made is controlled by the value of the
  168. environment variable `VERSION_CONTROL'.  If it is the string `simple',
  169. then only simple backups will be made.  If its value is the string
  170. `numbered', then numbered backups will be made.  If its value is
  171. `numbered-existing', then numbered backups will be made if there
  172. *already exist* numbered backups for the file being indented;
  173. otherwise, a simple backup is made.  If `VERSION_CONTROL' is not set,
  174. then `indent' assumes the behaviour of `numbered-existing'.
  175.  
  176.    Other versions of `indent' use the suffix `.BAK' in naming backup
  177. files.  This behaviour can be emulated by setting
  178. `SIMPLE_BACKUP_SUFFIX' to `.BAK'.
  179.  
  180.    Note also that other versions of `indent' make backups in the
  181. current directory, rather than in the directory of the source file as
  182. GNU `indent' now does.
  183.  
  185. File: indent.info,  Node: Common styles,  Next: Blank lines,  Prev: Backup files,  Up: Indent Program
  186.  
  187. Common styles
  188. =============
  189.  
  190.    There are several common styles of C code, including the GNU style,
  191. the Kernighan & Ritchie style, and the original Berkeley style.  A
  192. style may be selected with a single "background" option, which
  193. specifies a set of values for all other options.  However, explicitly
  194. specified options always override options implied by a background
  195. option.
  196.  
  197.    As of version 1.2, the default style of GNU `indent' is the GNU
  198. style.  Thus, it is no longer neccessary to specify the option `-gnu'
  199. to obtain this format, although doing so will not cause an error. 
  200. Option settings which correspond to the GNU style are:
  201.  
  202.      -nbad -bap -nbbb -nbc -bl -bli2 -c33 -cd33 -ncdb -nce
  203.      -cli0 -cp1 -di2 -nfc1 -nfca -i2 -ip5 -lp -pcs -psl -cs
  204.      -nsc -nsob -nss -ts8 -d0 -ci0 -l78
  205.  
  206.    The GNU coding style is that preferred by the GNU project.  It is the
  207. style that the GNU Emacs C mode encourages and which is used in the C
  208. portions of GNU Emacs.  (People interested in writing programs for
  209. Project GNU should get a copy of `The GNU Coding Standards', which also
  210. covers semantic and portability issues such as memory usage, the size
  211. of integers, etc.)
  212.  
  213.    The Kernighan & Ritchie style is used throughout their well-known
  214. book `The C Programming Language'.  It is enabled with the `-kr'
  215. option.  The Kernighan & Ritchie style corresponds to the following set
  216. of options:
  217.  
  218.      -nbad -bap -nbbb -nbc -br -c33 -cd33 -ncdb -ce -ci4
  219.      -cli0 -cp33 -d0 -di1 -nfc1 -nfca -i4 -ip0 -l75 -lp
  220.      -npcs -npsl -nsc -nsob -nss -ts8 -cs
  221.  
  222. Kernighan & Ritchie style does not put comments to the right of code in
  223. the same column at all times (nor does it use only one space to the
  224. right of the code), so for this style `indent' has arbitrarily chosen
  225. column 33.
  226.  
  227.    The style of the original Berkeley `indent' may be obtained by
  228. specifying `-orig' (or by specifyfying `--original', using the long
  229. option name).  This style is equivalent to the following settings:
  230.  
  231.      -nbap -nbad -nbbb -bc -br -c33 -cd33 -cdb -ce -ci4
  232.      -cli0 -cp33 -d4 -di16 -fc1 -fca -i4 -ip4 -l75 -lp
  233.      -npcs -psl -sc -nsob -nss -ts8 -ncs
  234.  
  236. File: indent.info,  Node: Blank lines,  Next: Comments,  Prev: Common styles,  Up: Indent Program
  237.  
  238. Blank lines
  239. ===========
  240.  
  241.    Various programming styles use blank lines in different places.
  242. `indent' has a number of options to insert or delete blank lines in
  243. specific places.
  244.  
  245.    The `-bad' option causes `indent' to force a blank line after every
  246. block of declarations.  The `-nbad' option causes `indent' not to force
  247. such blank lines.
  248.  
  249.    The `-bap' option forces a blank line after every procedure body.
  250. The `-nbap' option forces no such blank line.
  251.  
  252.    The `-bbb' option forces a blank line before every block comment. A
  253. block comment is one which starts in column one when formatting of such
  254. comments is disabled, or one with `-' or `*' immediately following the
  255. `/*'.  The `-nbbb' option does not force such blank lines.
  256.  
  257.    The `-sob' option causes `indent' to swallow optional blank lines
  258. (that is, any optional blank lines present in the input will be removed
  259. from the output).  If the `-nsob' is specified, any blank lines present
  260. in the input file will be copied to the output file.
  261.  
  262. * Menu:
  263.  
  264. * -bad::                        More on the `-bad' option.
  265. * -bap::                        More on the `-bap' option.
  266.  
  268. File: indent.info,  Node: -bad,  Next: -bap,  Up: Blank lines
  269.  
  270. --blank-lines-after-declarations
  271. --------------------------------
  272.  
  273.    The `-bad' option forces a blank line after every block of
  274. declarations.  The `-nbad' option does not add any such blank lines.
  275.  
  276.    For example, given the input
  277.      char *foo;
  278.      char *bar;
  279.      /* This separates blocks of declarations.  */
  280.      int baz;
  281.  
  282. `indent -bad' produces
  283.  
  284.      char *foo;
  285.      char *bar;
  286.      
  287.      /* This separates blocks of declarations.  */
  288.      int baz;
  289.  
  290. and `indent -nbad' produces
  291.  
  292.      char *foo;
  293.      char *bar;
  294.      /* This separates blocks of declarations.  */
  295.      int baz;
  296.  
  298. File: indent.info,  Node: -bap,  Prev: -bad,  Up: Blank lines
  299.  
  300. --blank-lines-after-procedures
  301. ------------------------------
  302.  
  303.    The `-bap' option forces a blank line after every procedure body.
  304.  
  305.    For example, given the input
  306.  
  307.      int
  308.      foo ()
  309.      {
  310.        puts("Hi");
  311.      }
  312.      /* The procedure bar is even less interesting.  */
  313.      char *
  314.      bar ()
  315.      {
  316.        puts("Hello");
  317.      }
  318.  
  319. `indent -bap' produces
  320.  
  321.      int
  322.      foo ()
  323.      {
  324.        puts ("Hi");
  325.      }
  326.      
  327.      /* The procedure bar is even less interesting.  */
  328.      char *
  329.      bar ()
  330.      {
  331.        puts ("Hello");
  332.      }
  333.  
  334. and `indent -nbap' produces
  335.  
  336.      int
  337.      foo ()
  338.      {
  339.        puts ("Hi");
  340.      }
  341.      /* The procedure bar is even less interesting.  */
  342.      char *
  343.      bar ()
  344.      {
  345.        puts ("Hello");
  346.      }
  347.  
  348. No blank line will be added after the procedure `foo'.
  349.  
  351. File: indent.info,  Node: Comments,  Next: Statements,  Prev: Blank lines,  Up: Indent Program
  352.  
  353. Comments
  354. ========
  355.  
  356.    Comments are no longer formatted by default as of version 1.2.  This
  357. can be enabled with the `-fca' option.  Doing so will cause newlines in
  358. the comment text to be ignored and the line will be filled up to the
  359. length of a line (which can be modified with `-l').  When formatting is
  360. enabled, blank lines indicate paragraph breaks.
  361.  
  362.    The `-fc1' option enables the formatting of comments which begin in
  363. the first column.  The `-nfc1' option disables the formatting of first
  364. column comments.  When comment formatting is disabled, overall comment
  365. indentation may still be adjusted.
  366.  
  367.    The indentation of comments which do not appear to the right of code
  368. is set by the `-d' option, which specifies the number of spaces to the
  369. left of the surrounding code that the comment appears.  For example,
  370. `-d2' places comments two spaces to the left of code; `-d0' lines up
  371. comments with the code.  The `-cdb' option controls whether the `/*'
  372. and `*/' are placed on blank lines.  With `-cdb', comments look like
  373. this:
  374.  
  375.      /*
  376.       * this is a comment
  377.       */
  378.  
  379. With `-ncdb', comments look like this:
  380.  
  381.      /* this is a comment */
  382.  
  383. `-cdb' only affects block comments, not comments to the right of code. 
  384. The default is `-ncdb'.
  385.  
  386.    Comments which appear on the same line as code are placed to the
  387. right. The column in which comments on code start is controlled by the
  388. `-c' option.  The column in which comments to the right of declarations
  389. start is controlled by the `-cd' option.  By default, they start in the
  390. same column as comments to the right of code, which is column 33.  The
  391. column number for comments to the right of `#else' and `#endif'
  392. statements is controlled by the `-cp' option.  If the code on a line
  393. extends past the comment column, the comment starts further to the
  394. right, and the right margin may be automatically extended in extreme
  395. cases.
  396.  
  397.    If the `-sc' option is specified, `*' is placed at the left edge of
  398. all comments.  For example:
  399.  
  400.      /* This is a comment which extends from one line
  401.       * onto the next line, thus causing us to consider
  402.       * how it should continue.  */
  403.  
  404. instead of
  405.  
  406.      /* This is a comment which extends from one line
  407.         onto the next line, thus causing us to consider
  408.         how it should continue.  */
  409.  
  411. File: indent.info,  Node: Statements,  Next: Declarations,  Prev: Comments,  Up: Indent Program
  412.  
  413. Statements
  414. ==========
  415.  
  416.    The `-br' or `-bl' option specifies how to format braces.
  417.  
  418.    The `-br' option formats braces like this:
  419.  
  420.      if (x > 0) {
  421.        x--;
  422.      }
  423.  
  424. The `-bl' option formats them like this:
  425.  
  426.      if (x > 0)
  427.        {
  428.          x--;
  429.        }
  430.  
  431.    If you use the `-bl' option, you may also want to specify the `-bli'
  432. option.  This option specifies the number of spaces by which braces are
  433. indented.  `-bli2', the default, gives the result shown above.  `-bli0'
  434. results in the following:
  435.  
  436.      if (x > 0)
  437.      {
  438.        x--;
  439.      }
  440.  
  441.    If you are using the `-br' option, you probably want to also use the
  442. `-ce' option.  This causes the `else' in an if-then-else construct to
  443. cuddle up to the immediately preceding `}'.  For example, with `-br
  444. -ce' you get the following:
  445.  
  446.      if (x > 0) {
  447.        x--;
  448.      } else {
  449.        fprintf (stderr, "...something wrong?\n");
  450.      }
  451.  
  452. With `-br -nce' that code would appear as
  453.  
  454.      if (x > 0) {
  455.        x--;
  456.      }
  457.      else {
  458.        fprintf (stderr, "...something wrong?\n");
  459.      }
  460.  
  461.    The `-cli' option specifies the number of spaces that case labels
  462. should be indented to the right of the containing `switch' statement.
  463.  
  464.    If a semicolon is on the same line as a `for' or `while' statement,
  465. the `-ss' option will cause a space to be placed before the semicolon. 
  466. This emphasizes the semicolon, making it clear that the body of the
  467. `for' or `while' statement is an empty statement. `-nss' disables this
  468. feature.
  469.  
  470.    The `-pcs' option causes a space to be placed between the name of
  471. the procedure being called and the `(' (for example, `puts ("Hi");'. 
  472. The `-npcs' option would give `puts("Hi");').
  473.  
  474.    If the `-cs' option is specified, `indent' puts a space after a cast
  475. operator.
  476.  
  477.    The `-bs' option ensures that there is a space between the keyword
  478. `sizeof' and its argument.  In some versions, this is known as the
  479. `Bill_Shannon' option.
  480.  
  482. File: indent.info,  Node: Declarations,  Next: Indentation,  Prev: Statements,  Up: Indent Program
  483.  
  484. Declarations
  485. ============
  486.  
  487.    By default `indent' will line up identifiers, in the column
  488. specified by the `-di' option.  For example, `-di16' makes things look
  489. like:
  490.  
  491.      int             foo;
  492.      char           *bar;
  493.  
  494.    Using a small value (such as one or two) for the `-di' option can be
  495. used to cause the indentifiers to be placed in the first available
  496. position, for example
  497.  
  498.      int foo;
  499.      char *bar;
  500.  
  501.    The value given to the `-di' option will still affect variables
  502. which are put on separate lines from their types, for example `-di2'
  503. will lead to
  504.  
  505.      int
  506.        foo;
  507.  
  508.    If the `-bc' option is specified, a newline is forced after each
  509. comma in a declaration.  For example,
  510.  
  511.      int a,
  512.        b,
  513.        c;
  514.  
  515. With the `-nbc' option this would look like
  516.  
  517.      int a, b, c;
  518.  
  519.    The `-psl' option causes the type of a procedure being defined to be
  520. placed on the line before the name of the procedure.  This style is
  521. required for the `etags' program to work correctly, as well as some of
  522. the `c-mode' functions of Emacs.
  523.  
  524.    If you are not using the `-di1' option to place variables being
  525. declared immediately after their type, you need to use the `-T' option
  526. to tell `indent' the name of all the typenames in your program that are
  527. defined by `typedef'.  `-T' can be specified more than once, and all
  528. names specified are used.  For example, if your program contains
  529.  
  530.      typedef unsigned long CODE_ADDR;
  531.      typedef enum {red, blue, green} COLOR;
  532.  
  533. you would use the options `-T CODE_ADDR -T COLOR'.
  534.  
  536. File: indent.info,  Node: Indentation,  Next: Miscellaneous options,  Prev: Declarations,  Up: Indent Program
  537.  
  538. Indentation
  539. ===========
  540.  
  541.    One issue in the formatting of code is how far each line should be
  542. indented from the left margin.  When the beginning of a statement such
  543. as `if' or `for' is encountered, the indentation level is increased by
  544. the value specified by the `-i' option.  For example, use `-i8' to
  545. specify an eight character indentation for each level. When a statement
  546. is continued from a previous line, it is indented by a number of
  547. additional spaces specified by the `-ci' option. `-ci' defaults to 0. 
  548. However, if the `-lp' option is specified, and a line has a left
  549. parenthesis which is not closed on that line, then continuation lines
  550. will be lined up to start at the character position just after the left
  551. parenthesis.  This processing also applies to `[' and applies to `{'
  552. when it occurs in initialization lists.  For example, a piece of
  553. continued code might look like this with `-nlp -ci3' in effect:
  554.  
  555.        p1 = first_procedure (second_procedure (p2, p3),
  556.           third_procedure (p4, p5));
  557.  
  558. With `-lp' in effect the code looks somewhat clearer:
  559.  
  560.        p1 = first_procedure (second_procedure (p2, p3),
  561.                              third_procedure (p4, p5));
  562.  
  563.    `indent' assumes that tabs are placed at regular intervals of both
  564. input and output character streams.  These intervals are by default 8
  565. columns wide, but (as of version 1.2) may be changed by the `-ts'
  566. option.  Tabs are treated as the equivalent number of spaces.
  567.  
  568.    The indentation of type declarations in old-style function
  569. definitions is controlled by the `-ip' parameter.  This is a numeric
  570. parameter specifying how many spaces to indent type declarations.  For
  571. example, the default `-ip5' makes definitions look like this:
  572.  
  573.      char *
  574.      create_world (x, y, scale)
  575.           int x;
  576.           int y;
  577.           float scale;
  578.      {
  579.        . . .
  580.      }
  581.  
  582.    For compatibility with other versions of indent, the option `-nip'
  583. is provided, which is equivalent to `-ip0'.
  584.  
  585.    ASCII C allows white space to be placed on preprocessor command lines
  586. between the character `#' and the command name.  By default, `indent'
  587. removes this space, but specifying the `-lps' option directs `indent'
  588. to leave this space unmodified.
  589.  
  591. File: indent.info,  Node: Miscellaneous options,  Next: Copyright,  Prev: Indentation,  Up: Indent Program
  592.  
  593. Miscellaneous options
  594. =====================
  595.  
  596.    To find out what version of `indent' you have, use the command
  597. `indent -version'.  This will report the version number of `indent',
  598. without doing any of the normal processing.
  599.  
  600.    The `-v' option can be used to turn on verbose mode.  When in
  601. verbose mode, `indent' reports when it splits one line of input into
  602. two more more lines of output, and gives some size statistics at
  603. completion.
  604.  
  606. File: indent.info,  Node: Copyright,  Prev: Miscellaneous options,  Up: Indent Program
  607.  
  608. Copyright
  609. =========
  610.  
  611.    The following copyright notice applies to the `indent' program. The
  612. copyright and copying permissions for this manual appear near the
  613. beginning of this document.
  614.  
  615.      Copyright (c) 1989, 1992 Free Software Foundation
  616.      Copyright (c) 1985 Sun Microsystems, Inc.
  617.      Copyright (c) 1980 The Regents of the University of California.
  618.      Copyright (c) 1976 Board of Trustees of the University of Illinois.
  619.      All rights reserved.
  620.      
  621.      Redistribution and use in source and binary forms are permitted
  622.      provided that the above copyright notice and this paragraph are
  623.      duplicated in all such forms and that any documentation,
  624.      advertising materials, and other materials related to such
  625.      distribution and use acknowledge that the software was developed
  626.      by the University of California, Berkeley, the University of Illinois,
  627.      Urbana, and Sun Microsystems, Inc.  The name of either University
  628.      or Sun Microsystems may not be used to endorse or promote products
  629.      derived from this software without specific prior written permission.
  630.      THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  631.      IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  632.      WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
  633.      PURPOSE.
  634.  
  636. File: indent.info,  Node: Option Summary,  Next: Index,  Prev: Indent Program,  Up: Top
  637.  
  638. Option Summary
  639. **************
  640.  
  641.    Here is a list of all the options for `indent', alphabetized by
  642. short option.  It is followed by a cross key alphabetized by long
  643. option.
  644.  
  645. `-bad'
  646. `--blank-lines-after-declarations'
  647.      Force blank lines after the declarations.
  648.      *Note Blank lines::.
  649.  
  650. `-bap'
  651. `--blank-lines-after-procedures'
  652.      Force blank lines after procedure bodies.
  653.      *Note Blank lines::.
  654.  
  655. `-bbb'
  656. `--blank-lines-after-block-comments'
  657.      Force blank lines after block comments.
  658.      *Note Blank lines::.
  659.  
  660. `-bc'
  661. `--blank-lines-after-commas'
  662.      Force newline after comma in declaration.
  663.      *Note Declarations::.
  664.  
  665. `-bl'
  666. `--braces-after-if-line'
  667.      Put braces on line after `if', etc.
  668.      *Note Statements::.
  669.  
  670. `-bliN'
  671. `--brace-indentN'
  672.      Indent braces N spaces.
  673.      *Note Statements::.
  674.  
  675. `-br'
  676. `--braces-on-if-line'
  677.      Put braces on line with `if', etc.
  678.      *Note Statements::.
  679.  
  680. `-cN'
  681. `--comment-indentationN'
  682.      Put comments to the right of code in column N.
  683.      *Note Comments::.
  684.  
  685. `-cdN'
  686. `--declaration-comment-columnN'
  687.      Put comments to the right of the declarations in column N.
  688.      *Note Comments::.
  689.  
  690. `-cdb'
  691. `--comment-delimiters-on-blank-lines'
  692.      Put comment delimiters on blank lines.
  693.      *Note Comments::.
  694.  
  695. `-ce'
  696. `--cuddle-else'
  697.      Cuddle else and preceeding `}'.
  698.      *Note Comments::.
  699.  
  700. `-ciN'
  701. `--continuation-indentationN'
  702.      Continuation indent of N spaces.
  703.      *Note Statements::.
  704.  
  705. `-cliN'
  706. `--case-indentationN'
  707.      Case label indent of N spaces.
  708.      *Note Statements::.
  709.  
  710. `-cpN'
  711. `--else-endif-columnN'
  712.      Put comments to the right of `#else' and `#endif' statements in
  713.      column N.
  714.      *Note Comments::.
  715.  
  716. `-cs'
  717. `--space-after-cast'
  718.      Put a space after a cast operator.
  719.      *Note Statements::.
  720.  
  721. `-bs'
  722. `--blank-before-sizeof'
  723.      Put a space between `sizeof' and its argument.
  724.      *Note Statements::
  725.  
  726. `-dN'
  727. `--line-comments-indentationN'
  728.      Set indentation of comments not to the right of code to N spaces.
  729.      *Note Comments::.
  730.  
  731. `-diN'
  732. `--declaration-indentationN'
  733.      Put variables in column N.
  734.      *Note Declarations::.
  735.  
  736. `-fc1'
  737. `--format-first-column-comments'
  738.      Format comments in the first column.
  739.      *Note Comments::.
  740.  
  741. `-fca'
  742. `--format-all-comments'
  743.      Do not disable all formatting of comments.
  744.      *Note Comments::
  745.  
  746. `-gnu'
  747. `--gnu-style'
  748.      Use GNU coding style.  This is the default.
  749.      *Note Common styles::.
  750.  
  751. `-iN'
  752. `--indent-levelN'
  753.      Set indentation level to N spaces.
  754.      *Note Indentation::.
  755.  
  756. `-ipN'
  757. `--parameter-indentationN'
  758.      Indent parameter types in old-style function definitions by N
  759.      spaces.
  760.      *Note Indentation::.
  761.  
  762. `-kr'
  763. `--k-and-r-style'
  764.      Use Kernighan & Ritchie coding style.
  765.      *Note Common styles::.
  766.  
  767. `-lN'
  768. `--line-lengthN'
  769.      Set maximum line length to N.
  770.      *Note Comments::.
  771.  
  772. `-lp'
  773. `--continue-at-parentheses'
  774.      Line up continued lines at parentheses.
  775.      *Note Indentation::.
  776.  
  777. `-lps'
  778. `--leave-preprocessor-space'
  779.      Leave space between `#' and preprocessor directive. *Note
  780.      Indentation::.
  781.  
  782. `-nbad'
  783. `--no-blank-lines-after-declarations'
  784.      Do not force blank lines after declarations.
  785.      *Note Blank lines::.
  786.  
  787. `-nbap'
  788. `--no-blank-lines-after-procedures'
  789.      Do not force blank lines after procedure bodies.
  790.      *Note Blank lines::.
  791.  
  792. `-nbbb'
  793. `--no-blank-lines-after-block-comments'
  794.      Do not force blank-lines after block comments.
  795.      *Note Blank lines::.
  796.  
  797. `-nbc'
  798. `--no-blank-lines-after-commas'
  799.      Do not force newlines after commas in declarations.
  800.      *Note Declarations::.
  801.  
  802. `-ncdb'
  803. `--no-comment-delimiters-on-blank-lines'
  804.      Do not put comment delimiters on blank lines.
  805.      *Note Comments::.
  806.  
  807. `-nce'
  808. `--dont-cuddle-else'
  809.      Do not cuddle `}' and `else'.
  810.      *Note Statements::.
  811.  
  812. `-ncs'
  813. `--no-space-after-casts'
  814.      Do not put a space after cast operators.
  815.      *Note Statements::.
  816.  
  817. `-nfc1'
  818. `--dont-format-first-column-comments'
  819.      Do not format comments in the first column as normal.
  820.      *Note Comments::.
  821.  
  822. `-nfca'
  823. `--dont-format-comments'
  824.      Do not format any comments.
  825.      *Note Comments::.
  826.  
  827. `-nip'
  828. `--no-parameter-indentation'
  829.      Zero width indentation for parameters.
  830.      *Note Indentation::
  831.  
  832. `-nlp'
  833. `--dont-line-up-parentheses'
  834.      Do not line up parentheses.
  835.      *Note Statements::.
  836.  
  837. `-npcs'
  838. `--no-space-after-function-call-names'
  839.      Do not put space after the function in function calls.
  840.      *Note Statements::.
  841.  
  842. `-npsl'
  843. `--dont-break-procedure-type'
  844.      Put the type of a procedure on the same line as its name.
  845.      *Note Declarations::.
  846.  
  847. `-nsc'
  848. `--dont-star-comments'
  849.      Do not put the `*' character at the left of comments.
  850.      *Note Comments::.
  851.  
  852. `-nsob'
  853. `--leave-optional-blank-lines'
  854.      Do not swallow optional blank lines.
  855.      *Note Blank lines::.
  856.  
  857. `-nss'
  858. `--dont-space-special-semicolon'
  859.      Do not force a space before the semicolon after certain statements.
  860.      Disables `-ss'.
  861.      *Note Statements::.
  862.  
  863. `-nv'
  864. `--no-verbosity'
  865.      Disable verbose mode. *Note Miscellaneous options::.
  866.  
  867. `-orig'
  868. `--original'
  869.      Use the original Berkeley coding style.
  870.      *Note Common styles::.
  871.  
  872. `-npro'
  873. `--ignore-profile'
  874.      Do not read `.indent.pro' files.
  875.      *Note Invoking indent::.
  876.  
  877. `-pcs'
  878. `--space-after-procedure-calls'
  879.      Insert a space between the name of the procedure being called and
  880.      the `('.
  881.      *Note Statements::.
  882.  
  883. `-psl'
  884. `--procnames-start-lines'
  885.      Put the type of a procedure on the line before its name.
  886.      *Note Declarations::.
  887.  
  888. `-sc'
  889. `--start-left-side-of-comments'
  890.      Put the `*' character at the left of comments.
  891.      *Note Comments::.
  892.  
  893. `-sob'
  894. `--swallow-optional-blank-lines'
  895.      Swallow optional blank lines.
  896.      *Note Blank lines::.
  897.  
  898. `-ss'
  899. `--space-special-semicolon'
  900.      On one-line `for' and `while' statments, force a blank before the
  901.      semicolon.
  902.      *Note Statements::.
  903.  
  904. `-st'
  905. `--standard-output'
  906.      Write to standard output.
  907.      *Note Invoking indent::.
  908.  
  909. `-T'
  910.      Tell `indent' the name of typenames.
  911.      *Note Declarations::.
  912.  
  913. `-tsN'
  914. `--tab-sizeN'
  915.      Set tab size to N spaces.
  916.      *Note Indentation::.
  917.  
  918. `-v'
  919. `--verbose'
  920.      Enable verbose mode.
  921.      *Note Miscellaneous options::.
  922.  
  923. `-version'
  924.      Output the version number of `indent'.
  925.      *Note Miscellaneous options::.
  926.  
  927. Options' Cross Key
  928. ------------------
  929.  
  930.    Here is a list of options alphabetized by long option, to help you
  931. find the corresponding short option.
  932.  
  933.      --blank-lines-after-block-comments              -bbb
  934.      --blank-lines-after-commas                      -bc
  935.      --blank-lines-after-declarations                -bad
  936.      --blank-lines-after-procedures                  -bap
  937.      --braces-after-if-line                          -bl
  938.      --brace-indent                                  -bli
  939.      --braces-on-if-line                             -br
  940.      --case-indentation                              -cliN
  941.      --comment-delimiters-on-blank-lines             -cdb
  942.      --comment-indentation                           -cN
  943.      --continuation-indentation                      -ciN
  944.      --continue-at-parentheses                       -lp
  945.      --cuddle-else                                   -ce
  946.      --declaration-comment-column                    -cdN
  947.      --declaration-indentation                       -diN
  948.      --dont-break-procedure-type                     -npsl
  949.      --dont-cuddle-else                              -nce
  950.      --dont-format-comments                          -nfca
  951.      --dont-format-first-column-comments             -nfc1
  952.      --dont-line-up-parentheses                      -nlp
  953.      --dont-space-special-semicolon                  -nss
  954.      --dont-star-comments                            -nsc
  955.      --else-endif-column                             -cpN
  956.      --format-all-comments                           -fca
  957.      --format-first-column-comments                  -fc1
  958.      --gnu-style                                     -gnu
  959.      --ignore-profile                                -npro
  960.      --indent-level                                  -iN
  961.      --k-and-r-style                                 -kr
  962.      --leave-optional-blank-lines                    -nsob
  963.      --leave-preprocessor-space                      -lps
  964.      --line-comments-indentation                     -dN
  965.      --line-length                                   -lN
  966.      --no-blank-lines-after-block-comments           -nbbb
  967.      --no-blank-lines-after-commas                   -nbc
  968.      --no-blank-lines-after-declarations             -nbad
  969.      --no-blank-lines-after-procedures               -nbap
  970.      --no-comment-delimiters-on-blank-lines          -ncdb
  971.      --no-space-after-casts                          -ncs
  972.      --no-parameter-indentation                      -nip
  973.      --no-space-after-function-call-names            -npcs
  974.      --no-verbosity                                  -nv
  975.      --original                                      -orig
  976.      --parameter-indentation                         -ipN
  977.      --procnames-start-lines                         -psl
  978.      --space-after-cast                              -cs
  979.      --space-after-procedure-calls                   -pcs
  980.      --space-special-semicolon                       -ss
  981.      --standard-output                               -st
  982.      --start-left-side-of-comments                   -sc
  983.      --swallow-optional-blank-lines                  -sob
  984.      --tab-size                                      -tsN
  985.      --verbose                                       -v
  986.  
  988. File: indent.info,  Node: Index,  Prev: Option Summary,  Up: Top
  989.  
  990. Index
  991. *****
  992.  
  993. * Menu:
  994.  
  995. * --blank-after-sizeof:                 Statements.
  996. * --blank-lines-after-block-comments:   Blank lines.
  997. * --blank-lines-after-commas:           Declarations.
  998. * --blank-lines-after-declarations:     -bad.
  999. * --blank-lines-after-procedures:       -bap.
  1000. * --brace-indentN:                      Statements.
  1001. * --braces-after-if-line:               Statements.
  1002. * --braces-on-if-line:                  Statements.
  1003. * --case-indentationN:                  Statements.
  1004. * --comment-delimiters-on-blank-lines:  Comments.
  1005. * --comment-indentationN:               Comments.
  1006. * --continuation-indentationN:          Indentation.
  1007. * --continue-at-parentheses:            Indentation.
  1008. * --cuddle-else:                        Statements.
  1009. * --declaration-comment-columnN:        Comments.
  1010. * --declaration-indentationN:           Declarations.
  1011. * --dont-break-procedure-type:          Declarations.
  1012. * --dont-cuddle-else:                   Statements.
  1013. * --dont-format-comments:               Comments.
  1014. * --dont-format-first-column-comments:  Comments.
  1015. * --dont-line-up-parentheses:           Indentation.
  1016. * --dont-space-special-semicolon:       Statements.
  1017. * --dont-star-comments:                 Comments.
  1018. * --else-endif-columnN:                 Comments.
  1019. * --format-all-comments:                Comments.
  1020. * --format-first-column-comments:       Comments.
  1021. * --gnu-style:                          Common styles.
  1022. * --ignore-profile:                     Invoking indent.
  1023. * --indent-levelN:                      Indentation.
  1024. * --k-and-r-style:                      Common styles.
  1025. * --leave-optional-blank-lines:         Blank lines.
  1026. * --leave-preprocessor-space:           Indentation.
  1027. * --line-comments-indentationN:         Comments.
  1028. * --line-lengthN:                       Comments.
  1029. * --no-blank-lines-after-block-comments: Blank lines.
  1030. * --no-blank-lines-after-commas:        Declarations.
  1031. * --no-blank-lines-after-declarations:  -bad.
  1032. * --no-blank-lines-after-procedures:    -bap.
  1033. * --no-comment-delimiters-on-blank-lines: Comments.
  1034. * --no-parameter-indentation:           Indentation.
  1035. * --no-space-after-casts:               Statements.
  1036. * --no-space-after-function-call-names: Statements.
  1037. * --no-verbosity:                       Miscellaneous options.
  1038. * --original:                           Common styles.
  1039. * --output-file:                        Invoking indent.
  1040. * --parameter-indentationN:             Indentation.
  1041. * --procnames-start-lines:              Declarations.
  1042. * --space-after-cast:                   Statements.
  1043. * --space-after-procedure-calls:        Statements.
  1044. * --space-special-semicolon:            Statements.
  1045. * --standard-output:                    Invoking indent.
  1046. * --start-left-side-of-comments:        Comments.
  1047. * --swallow-optional-blank-lines:       Blank lines.
  1048. * --tab-sizeN:                          Indentation.
  1049. * --verbose:                            Miscellaneous options.
  1050. * -T:                                   Declarations.
  1051. * -bad:                                 -bad.
  1052. * -bap:                                 -bap.
  1053. * -bbb:                                 Blank lines.
  1054. * -bc:                                  Declarations.
  1055. * -bl:                                  Statements.
  1056. * -bliN:                                Statements.
  1057. * -br:                                  Statements.
  1058. * -bs:                                  Statements.
  1059. * -cN:                                  Comments.
  1060. * -cdN:                                 Comments.
  1061. * -cdb:                                 Comments.
  1062. * -ce:                                  Statements.
  1063. * -ciN:                                 Indentation.
  1064. * -cliN:                                Statements.
  1065. * -cpN:                                 Comments.
  1066. * -cs:                                  Statements.
  1067. * -dN:                                  Comments.
  1068. * -dce:                                 Statements.
  1069. * -diN:                                 Declarations.
  1070. * -fc1:                                 Comments.
  1071. * -fca:                                 Comments.
  1072. * -gnu:                                 Common styles.
  1073. * -iN:                                  Indentation.
  1074. * -ipN:                                 Indentation.
  1075. * -kr:                                  Common styles.
  1076. * -lN:                                  Comments.
  1077. * -lp:                                  Indentation.
  1078. * -lps:                                 Indentation.
  1079. * -nbad:                                -bad.
  1080. * -nbap:                                -bap.
  1081. * -nbbb:                                Blank lines.
  1082. * -nbc:                                 Declarations.
  1083. * -ncdb:                                Comments.
  1084. * -ncs:                                 Statements.
  1085. * -nfc1:                                Comments.
  1086. * -nfca:                                Comments.
  1087. * -nip:                                 Indentation.
  1088. * -nlp:                                 Indentation.
  1089. * -npcs:                                Statements.
  1090. * -npro:                                Invoking indent.
  1091. * -npsl:                                Declarations.
  1092. * -nsc:                                 Comments.
  1093. * -nsob:                                Blank lines.
  1094. * -nss:                                 Statements.
  1095. * -nv:                                  Miscellaneous options.
  1096. * -o:                                   Invoking indent.
  1097. * -orig:                                Common styles.
  1098. * -pcs:                                 Statements.
  1099. * -psl:                                 Declarations.
  1100. * -sc:                                  Comments.
  1101. * -sob:                                 Blank lines.
  1102. * -ss:                                  Statements.
  1103. * -st:                                  Invoking indent.
  1104. * -tsN:                                 Indentation.
  1105. * -v:                                   Miscellaneous options.
  1106. * -version:                             Miscellaneous options.
  1107. * etags requires -psl:                  Declarations.
  1108. * .indent.pro file:                     Invoking indent.
  1109. * Beginning indent:                     Invoking indent.
  1110. * Berkeley style:                       Common styles.
  1111. * Blank lines:                          Blank lines.
  1112. * Comments:                             Comments.
  1113. * GNU style:                            Common styles.
  1114. * Initialization file:                  Invoking indent.
  1115. * Invoking indent:                      Invoking indent.
  1116. * Kernighan & Ritchie style:            Common styles.
  1117. * Long options, use of:                 Invoking indent.
  1118. * Original Berkeley style:              Common styles.
  1119. * Output File Specification:            Invoking indent.
  1120. * Standard Output:                      Invoking indent.
  1121. * Starting indent:                      Invoking indent.
  1122. * Typenames:                            Declarations.
  1123. * Using Standard Input:                 Invoking indent.
  1124.  
  1125.  
  1127. Tag Table:
  1128. Node: Top410
  1129. Node: Indent Program918
  1130. Node: Invoking indent1865
  1131. Node: Backup files5046
  1132. Node: Common styles6913
  1133. Node: Blank lines9137
  1134. Node: -bad10363
  1135. Node: -bap11012
  1136. Node: Comments11875
  1137. Node: Statements14249
  1138. Node: Declarations16248
  1139. Node: Indentation17865
  1140. Node: Miscellaneous options20182
  1141. Node: Copyright20729
  1142. Node: Option Summary22125
  1143. Node: Index31669
  1145. End Tag Table
  1146.